POST Stop and Cut Live Video

Overview

---

The table below provides key details about the POST method for stopping and cutting Live Video

POST Stop and Cut Live Video
Method	POST
URL or Endpoint	/api/v2/projectId/live-videos/id/stop-and-cut
Headers	Authorization
Content Type	application/json
Parameters	id, projectId
Request Body	dateTimeFrom, dateTimeTo, fromMilisecond, toMilisecond, videoVisibilityOptionId

The description of the URL parameter is as follows:

id URL Parameter
URL Parameter Name	id
Mandatory	Yes
Type	string
Description	Unique Id of the live video.

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "dateTimeFrom": "2024-11-13T13:05:31.392Z",
  "dateTimeTo": "2024-11-13T13:05:31.392Z",
  "fromMilisecond": 0,
  "toMilisecond": 0,
  "videoVisibilityOptionId": 0
}

tip

For more information about visibility options, please visit the Visibility Options API

Information about the fields that appear on body request are displayed in the table below.

Field Name	Type	Description
dateTimeFrom	string (ISO 8601 datetime)	Start date and time for the event in ISO format.
dateTimeTo	string (ISO 8601 datetime)	End date and time for the event in ISO format.
fromMilisecond	integer	Start time in milliseconds within the video.
toMilisecond	integer	End time in milliseconds within the video.
videoVisibilityOptionId	integer	Identifier for the video visibility option.

Response

{
    "success": true,
    "errors": [],
    "messages": [],
    "result": {
        "videoPublicId": "string"
    },
    "resultInfo": null,
    "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
videoPublicId	string	Returns public identifier of the video
result	array[Object]	Returns the response object.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed